pp108 : Event Handling Service Connector APIs

Event Handling Service Connector APIs

This topic describes the APIs for the Event Service Connector.

Introduction

An Event Service is used to publish all events that occur over Process Platform to the subscribers of the event.

Event Service Connector APIs

  • Publish

    Note:
    Whenever a Publish request is sent to the Event Service, the service retrieves the subject from the request. A SOAP message containing a clone of the XML in the event tag of the request is created. In addition, the Event service makes a clone of the header in the SOAP message containing the Publish request and uses that as the header in the new SOAP message. The new SOAP message is sent to every subscriber in the subscriber list. Simultaneously, the Event Service tries to validate the subscriber that was in the subscribe request for a subject. If the validation fails, the subscriber is removed from the subscriber list immediately. Consider an anonymous client subscribed with its socket address. When the client stops executing, it does not read the socket address. Hence, the Event service cannot send the Publish SOAP message. In this case, the Event service removes the anonymous client from the list.

  • Subscribe
  • Unsubscribe
  • GetSubscribers
  • GetAllSubscriptions: This Web service operation is used to retrieve all subscriptions available in the Event service.

    Note:
    When the above SOAP messages are sent to the Event Service, a timeout exception error message is generated as the Event service does not return any SOAP response. Even though publishing, subscribing, or unsubscribing may be successful, the timeout exception error occurs in the absence of a response message. To avoid the timeout exception, the synchronous tag must be used.